The functions in this section are exposed in the Business Entities > Library Types > NEVA once the Direct.NEVA.dll is added as a reference.
To add NEVA library objects to your project:
| 1. | Select Project > References > Library References. |
| 2. | Click New Reference. |
| 3. | Navigate to C:\Program Files (x86)\NICE Systems\Real-Time Designer. |
| 4. | Select Direct.NEVA.dll and click Open. |
Most of the NEVA functions are sync functions, that is, further execution waits until NEVA receives a reply from Amazon Lex (or times out).
|
Function |
Sync / Async |
Return Value |
Description |
Syntax |
|---|---|---|---|---|
| Add NEVA Error |
Sync |
--- | Inserts error text on the NEVA callout. | Add NEVA Error <Select text> |
| Add NEVA Message |
Sync |
--- | Posts text as NEVA, simulating a response message. | Add NEVA Message <Select text> |
| Add User Message |
Sync |
--- | Posts text as if it were the agent (and sends the text to Amazon LEX). | Add User Message <Select text> |
| Change Emotion |
Sync |
--- | Changes NEVA's emotions by setting the function parameter to the emotion file name (without the file extension). See Configuring NEVA Emotions. | Change Emotion <Select text> |
| Clear All Messages |
Sync |
--- | Clears all NEVA messages. | Clear All Messages |
| Create NEVA |
Sync |
--- | Launches the NEVA window with the settings provided. See Creating the NEVA Settings Business Entity. | Create NEVA <Select settings> |
| Destroy NEVA |
Sync |
--- | Terminates NEVA and closes the NEVA window. | Destroy NEVA |
| Disable NEVA Input |
Sync |
--- | Disables NEVA input. This blocks user input. | Disable NEVA Input |
| Enable NEVA Input |
Sync |
--- |
Enables NEVA input. This allows user input. |
Enable NEVA Input |
|
Is NEVA Busy |
Async |
Boolean |
Establishes whether NEVA is busy (True/False). This checks whether NEVA is waiting for a response from Amazon Lex. All sync NEVA function calls will be blocked until a response is received or it times out. |
Is NEVA Busy |
|
Is NEVA Created |
Async |
Boolean |
Establishes whether NEVA was created (True/False). |
Is NEVA Created |
| Is NEVA Minimized |
Async |
Boolean |
Establishes whether NEVA is minimized in the system tray (True/False). |
Is NEVA Minimized |
|
Minimize NEVA |
Async |
--- |
Minimizes the NEVA window. |
Minimize NEVA |
|
Reset Conversation Context |
Sync |
--- |
Resets the conversation. Amazon Lex is now ready to start a new conversation. |
Reset Conversation Context |
|
Set Attributes(List of NEVA Name Pair Value) |
Sync |
---- |
Sets the attributes using a list of NEVA Name Value Pair Business Entities. |
Set Attributes <Add attributes> |
|
Set Greeting(Headline, Greeting) |
Sync |
---- |
Sets the headline that appears in bold on the top of the NEVA window, next to the NEVA icon. Sets the greeting that appears in regular text on the top of the NEVA window, next to the NEVA icon. |
Set Greeting <Select Headline> , <Greeting> |
|
Show NEVA |
Async |
---- |
Restores the NEVA window to its previous location. |
Show NEVA |
|
Wait for NEVA Ready |
Sync |
---- |
Waits for NEVA to be ready. This is a sync function, meaning it waits until NEVA replies. |
Wait for NEVA Ready |
